Documentation forSolarWinds Observability SaaS

Configure Agent in locally managed mode

To use any of the integrations, add the integration to the local_config.yaml file and specify a list of instances to run, e.g.:

integrations:

  otel/hostmetrics:

    - name: host-monitoring

dbo/mysql:

  - name: mysql-1

  # ... settings for the mysql integration

dbo/redis:

  - name: redis-1

  # ... settings for the redis integration

The OTel integrationsare not displayed in SolarWinds Observability SaaS, but the corresponding entities will be created.

The name field must be unique.

Host monitoring

To monitor the host containing the deployed SolarWinds Observability Agent, add the otel/hostmetrics integration to your local_config.yaml file and specify the instance name:

integrations:

  otel/hostmetrics:

    - name: host-monitoring

Database monitoring

MySQL

To monitor a MySQL database, add the dbo/mysql integration to your local_config.yaml file and specify the required parameters:

integrations:
  dbo/mysql:
    - name: mysql-local-conf-off-host
      host: 10.0.2.2
      port: 3306
      user: root
      password:
        value-from:
          provider: aws-secrets-manager
          secret-name: dev/uams/mysql
          secret-key: mysql-database-password
    - name: mysql-local-conf-on-host
      host: 10.0.2.2
      port: 3306
      packet-capture-enabled: true
      binding: 0.0.0.0:3306,[::]:3306,10.0.2.2:3306
      user: root
      password:
        value-from:
          provider: file
          path: /opt/solarwinds/uamsclient/var/local_config_cred.yaml

The example includes host monitoring and credentials from AWS Secrets Manager and a local file.

The following is a list of standard configuration parameters. For optional advanced configuration options, such as disabling sampling and setting the long-running query event threshold, see Database configuration files.

Parameter Allowed values Description

host

<MySQLServer_Host>

MySQL server IP.

port

<MySQLServer_Port>

MySQL server Port.

password

See Locally managed mode credential providers. This is mandatory if useIAMAsAuthMethod is not set to true.

packet-capture-enabled

[true/false]

[Optional] If true, packet sniffing is used by DBO agent. In this case, the DBO agent and DB server need to be running on same host.

binding

<IP:Port>

[Optional] Can be provided in case packet capture is enabled.

useIAMAsAuthMethod

[true/false]

[Optional] Use AWS IAM Auth for database authentication.

Default: false

region

<AWS_Region>

[Optional] AWS region - mandatory if useIAMAsAuthMethod=true.

PostgreSQL

To monitor a PostgreSQL database, add the dbo/pgsql integration to your local_config.yaml file and specify the required parameters:

integrations:
  dbo/pgsql:
    - name: pgsql-local-conf-off-host
      host: 10.0.2.2
      port: 5432
      user: myuser
      password:
        value-from:
          provider: file
          path: /opt/solarwinds/uamsclient/var/local_config_cred.yaml
          key: pgsql-pass-2
    - name: pgsql-local-conf-on-host
      host: 10.0.2.2
      port: 5432
      packet-capture-enabled: true
      binding: 0.0.0.0:5432,[::]:5432,10.0.2.2:5432
      user: myuser
      password:
        value-from:
          provider: file
          path: /opt/solarwinds/uamsclient/var/local_config_cred.yaml
          key: pgsql-pass-2

The following is a list of standard configuration parameters. For optional advanced configuration options, such as disabling sampling and setting the long-running query event threshold, see Database configuration files.

Parameter Allowed values Description

host

<PostgreSQLServer_Host>

PostgreSQL server IP.

port

<PostgreSQLServer_Port>

PostgreSQL server Port.

database

<PostgreSQLServer_Database>

Database on PostgreSQL server to connect to.

password

See Locally managed mode credential providers. This is mandatory IAM is not being used for authentication.

packet-capture-enabled

[true/false]

[Optional] If true, packet sniffing is used by DBO agent. In this case, the DBO agent and DB server need to be running on same host.

binding

<IP:Port>

[Optional] Can be provided in case packet capture is enabled.

useIAMAsAuthMethod

[true/false]

[Optional] Use AWS IAM for database authentication.

Default: false

region

<AWS_Region>

[Optional] AWS region - mandatory if useIAMAsAuthMethod=true.

Redis

To monitor a Redis database, add the dbo/redis integration to your local_config.yaml file and specify the required parameters:

integrations:
  dbo/redis:
    - name: redis-local-conf
      host: localhost
      port: 6379
      binding: 0.0.0.0:6379,[::]:6379
      packet-capture-enabled: true
      password:
        value-from:
          provider: hashicorp-vault
          secret: databases/passwords
          key: redis_password

The example includes credentials from Hashicorp Vault.

The following is a list of standard configuration parameters. For optional advanced configuration options, such as disabling sampling and setting the long-running query event threshold, see Database configuration files.

Parameter Allowed values Description

host

<RedisServer_Host>

Redis server IP.

port

<RedisServer_Port>

Redis server Port.

password

See Locally managed mode credential providers.

binding

<IP:Port>

[Optional].

MongoDB

To monitor a MongoDB database, add the dbo/mongo integration to your local_config.yaml file and specify the required parameters:

integrations:
  dbo/mongo:
    - name: mongo-test-local-config
      host: 10.0.2.2
      port: 27018
      user: myUser
      password:
        value-from:
          provider: file
          path: /opt/solarwinds/uamsclient/var/local_config_cred.yaml
          key: credential-one
      off-host-method: profiler
    - name: mongo-test-local-config-sniffer
      host: 10.0.2.2
      port: 27018
      user: myUser
      password:
        value-from:
          provider: file
          path: /opt/solarwinds/uamsclient/var/local_config_cred.yaml
          key: credential-one
      binding: 0.0.0.0:27018,[::]:27018,10.0.2.2:27018
      packet-capture-enabled: true
    - name: mongo-test-local-config-slow-log
      host: 10.0.2.2
      port: 27018
      user: myUser
      password:
        value-from:
          provider: file
          path: /opt/solarwinds/uamsclient/var/local_config_cred.yaml
          key: credential-one
      off-host-method: slow-log

The following is a list of standard configuration parameters. For optional advanced configuration options, such as disabling sampling and setting the long-running query event threshold, see Database configuration files.

Parameter Allowed values Description

host

<MongoServer_Host>

Mongo server IP.

port

<MongoServer_Port>

Mongo server Port.

user

<MongoServer_User>

Mongo user.

password

See Locally managed mode credential providers.

packet-capture-enabled

[true/false]

[Optional] If true, packet sniffing is used by DBO agent. In this case, the DBO agent and DB server need to be running on same host.

binding

<IP:Port>

[Optional] Can be provided in case packet capture is enabled.

off-host-method

[profiler/slow-log]

Mandatory if packet-capture-enabled=false.

SQL server

To monitor a SQL Server database, add the dbo/mssql integration to your local_config.yaml file and specify the required parameters:

integrations:
  dbo/mssql:
    - name: mssql-local-conf
      host: localhost
      port: 1433
      user: SA
      password:
        value-from:
          provider: file
          path: /opt/solarwinds/uamsclient/var/local_config_cred.yaml
          key: mssql-pass

The following is a list of standard configuration parameters. For optional advanced configuration options, such as disabling sampling and setting the long-running query event threshold, see Database configuration files.

Parameter Allowed values Description

host

<SQLServer_Host>

SQL Server server IP.

port

<SQLServer_Port>

SQL Server server Port.

Port can be skipped if using a named SQL Server.

user

<SQLServer_User>

SQL Server server User.

password

See Locally managed mode credential providers.

OTel-based monitoring

Apache receiver

Configure the Apache server first.

To monitor Apache, add the otel/apache integration to your local_config.yaml file and specify the required parameters.

integrations:
  otel/apache:
    - name: test-apache-server
      status-url: http://localhost:80/server-status?auto
      collection-interval: 5s

The example includes a username and password from Akeyless.

Docker receiver

Grant the agent access to the Docker socket file first.

To monitor Docker, add the otel/docker integration to your local_config.yaml file and specify the required parameters.

integrations:
  otel/docker:
    - name: test-docker
      status-url: unix:///var/run/docker.sock
      collection-interval: 5s

Elasticsearch receiver

Configure the Elasticsearch server first.

To monitor Elasticsearch, add the otel/elasticsearch integration to your local_config.yaml file and specify the required parameters.

integrations:
  otel/elasticsearch:
    - name: test-elasticsearch
      status-url: http://localhost:9200
      collection-interval: 5s
      username:
        value-from:
          provider: file
          path: /opt/solarwinds/uamsclient/var/my_passwords_conf.yaml
          key: username-es
      password:
          value-from:
            provider: file
            path: /opt/solarwinds/uamsclient/var/my_passwords_local_conf.yaml
            key: password-es

Filelog receiver

To monitor Filelog, add the otel/filelog integration to your local_config.yaml file and specify the required parameters.

integrations:
  otel/filelog:
    - name: test-filelog
      log_path: /var/log/solarwinds/uamsclient/*
      poll_interval: 200ms
      start_at: end
      encoding: utf-8

Possible values for start_at: end, beginning

Possible values for encoding:

Key Description

utf-8

UTF-8 encoding. Default

utf-16le

UTF-16 encoding with little-endian byte order

utf-16be

UTF-16 encoding with big-endian byte order

ascii

ASCII encoding

big5

The Big5 Chinese character encoding

IIS receiver

ISS is only supported on Windows.

To monitor ISS, add the otel/iss integration to your local_config.yaml file and specify the required parameters.

integrations:
  otel/iss:
    - name: test-iss
      collection-interval: 5s

Kafka receiver

Configure the Elasticsearch server first.

To monitor Kafka, add the otel/kafka integration to your local_config.yaml file and specify the required parameters.

integrations:
  otel/kafka:
    - name: test-kafka
      status-url: localhost:1234
      collection-interval: 5s

NGINX receiver

Configure the NGINX server first.

To monitor NGINX, add the otel/nginx integration to your local_config.yaml file and specify the required parameters.

integrations:
  otel/nginx:
    - name: test-nginx
      status-url: http://localhost:80/status
      collection-interval: 5s

Redis

To monitor Redis, add the otel/redis integration to your local_config.yaml file and specify the required parameters.

integrations:
  otel/redis:
    - name: test-redis
      status-url: localhost:2181
      collection-interval: 5s
      password:
        value-from:
          provider: aws-secrets-manager
          secret-name: secret-id

Zookeeper receiver

Configure the Zookeeper server first.

To monitor Zookeeper, add the otel/zookeeper integration to your local_config.yaml file and specify the required parameters.

integrations:
  otel/zookeeper:
    - name: test-zookeeper
      status-url: localhost:2181
      collection-interval: 5s